package org.maxgroundstation.groundstation.view.overlay;

import java.awt.Graphics;

/**
 * An interface for a camera overlay graphic.
 * @author Scott Davis
 * 
 * Copyright (C) 2010  Scott Davis
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
public interface Overlay {

    /**
     * Gets the name of the overlay.
     * @return name.
     */
    public String getName();
    
    /**
     * Sets if the overlay should display or not.
     * @param displayOverlay true if display overlay.
     */
    public void setDisplay(boolean displayOverlay);
    
    /**
     * Checks if the overlay should display or not.
     * @return true if display overlay.
     */
    public boolean getDisplay();
    
    /**
     * Checks if the overlay can display or not.
     * @return true if overlay can display.
     */
    public boolean canDisplay();
    
    /**
     * Paints the overlay graphics.
     * @param g the graphics context.
     * @param panelWidth the panel width.
     * @param panelHeight the panel height.
     */
    public void paintOverlay(Graphics g, int panelWidth, int panelHeight);
}